<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>AbstractInstant xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/goda/time/base/AbstractInstant.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2006 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time.base;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.util.Date;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.goda.time.Chronology;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTime;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeField;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeFieldType;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeUtils;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.goda.time.DateTimeZone;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.goda.time.Instant;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.goda.time.MutableDateTime;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadableInstant;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.goda.time.chrono.ISOChronology;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.goda.time.field.FieldUtils;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.goda.time.format.DateTimeFormatter;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.goda.time.format.ISODateTimeFormat;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">/**</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * AbstractInstant provides the common behaviour for instant classes.</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * This class has no concept of a chronology, all methods work on the</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * millisecond instant.</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * This class should generally not be used directly by API users. The </em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * {@link ReadableInstant} interface should be used when different </em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * kinds of date/time objects are to be referenced.</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * Whenever you want to implement &lt;code&gt;ReadableInstant&lt;/code&gt; you should</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * extend this class.</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * AbstractInstant itself is thread-safe and immutable, but subclasses may be</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * mutable and not thread-safe.</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> *</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> */</em>
<a name="54" href="#54">54</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/goda/time/base/AbstractInstant.html">AbstractInstant</a> implements <a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> {
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * Constructor.</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">protected</strong> <a href="../../../../org/goda/time/base/AbstractInstant.html">AbstractInstant</a>() {
<a name="60" href="#60">60</a>          <strong class="jxr_keyword">super</strong>();
<a name="61" href="#61">61</a>      }
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="64" href="#64">64</a>      <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * Gets the time zone of the instant from the chronology.</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * </em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     * @return the DateTimeZone that the instant is using, never null</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     */</em>
<a name="69" href="#69">69</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> getZone() {
<a name="70" href="#70">70</a>          <strong class="jxr_keyword">return</strong> getChronology().getZone();
<a name="71" href="#71">71</a>      }
<a name="72" href="#72">72</a>  
<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * Get the value of one of the fields of a datetime using the chronology of the instant.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * This method uses the chronology of the instant to obtain the value.</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * For example:</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * DateTime dt = new DateTime();</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * int year = dt.get(DateTimeFieldType.year());</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     *</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * @param type  a field type, usually obtained from DateTimeFieldType, not null</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @return the value of that field</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the field type is null</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     */</em>
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> get(<a href="../../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> type) {
<a name="88" href="#88">88</a>          <strong class="jxr_keyword">if</strong> (type == <strong class="jxr_keyword">null</strong>) {
<a name="89" href="#89">89</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The DateTimeFieldType must not be null"</span>);
<a name="90" href="#90">90</a>          }
<a name="91" href="#91">91</a>          <strong class="jxr_keyword">return</strong> type.getField(getChronology()).get(getMillis());
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <em class="jxr_javadoccomment">/**</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * Checks if the field type specified is supported by this instant and chronology.</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * This can be used to avoid exceptions in {@link #get(DateTimeFieldType)}.</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     *</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @param type  a field type, usually obtained from DateTimeFieldType</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * @return true if the field type is supported</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     */</em>
<a name="101" href="#101">101</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSupported(<a href="../../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> type) {
<a name="102" href="#102">102</a>         <strong class="jxr_keyword">if</strong> (type == <strong class="jxr_keyword">null</strong>) {
<a name="103" href="#103">103</a>             <strong class="jxr_keyword">return</strong> false;
<a name="104" href="#104">104</a>         }
<a name="105" href="#105">105</a>         <strong class="jxr_keyword">return</strong> type.getField(getChronology()).isSupported();
<a name="106" href="#106">106</a>     }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * Get the value of one of the fields of a datetime.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * This could be used to get a field using a different Chronology.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * For example:</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * Instant dt = new Instant();</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * int gjYear = dt.get(Chronology.getCoptic().year());</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * </em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * @param field  the DateTimeField to use, not null</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * @return the value</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the field is null</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     */</em>
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> get(<a href="../../../../org/goda/time/DateTimeField.html">DateTimeField</a> field) {
<a name="123" href="#123">123</a>         <strong class="jxr_keyword">if</strong> (field == <strong class="jxr_keyword">null</strong>) {
<a name="124" href="#124">124</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The DateTimeField must not be null"</span>);
<a name="125" href="#125">125</a>         }
<a name="126" href="#126">126</a>         <strong class="jxr_keyword">return</strong> field.get(getMillis());
<a name="127" href="#127">127</a>     }
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="130" href="#130">130</a>     <em class="jxr_javadoccomment">/**</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * Get this object as an Instant.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * </em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * @return an Instant using the same millis</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     */</em>
<a name="135" href="#135">135</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/Instant.html">Instant</a> toInstant() {
<a name="136" href="#136">136</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/Instant.html">Instant</a>(getMillis());
<a name="137" href="#137">137</a>     }
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * Get this object as a DateTime in the same zone.</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     *</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * @return a DateTime using the same millis</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     */</em>
<a name="144" href="#144">144</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a> toDateTime() {
<a name="145" href="#145">145</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a>(getMillis(), getZone());
<a name="146" href="#146">146</a>     }
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>     <em class="jxr_javadoccomment">/**</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * Get this object as a DateTime using ISOChronology in the same zone.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     *</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * @return a DateTime using the same millis with ISOChronology</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     */</em>
<a name="153" href="#153">153</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a> toDateTimeISO() {
<a name="154" href="#154">154</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a>(getMillis(), ISOChronology.getInstance(getZone()));
<a name="155" href="#155">155</a>     }
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <em class="jxr_javadoccomment">/**</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * Get this object as a DateTime using the same chronology but a different zone.</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * </em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * @param zone time zone to apply, or default if null</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * @return a DateTime using the same millis</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     */</em>
<a name="163" href="#163">163</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a> toDateTime(<a href="../../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> zone) {
<a name="164" href="#164">164</a>         <a href="../../../../org/goda/time/Chronology.html">Chronology</a> chrono = DateTimeUtils.getChronology(getChronology());
<a name="165" href="#165">165</a>         chrono = chrono.withZone(zone);
<a name="166" href="#166">166</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a>(getMillis(), chrono);
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Get this object as a DateTime using the given chronology and its zone.</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * </em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * @param chronology chronology to apply, or ISOChronology if null</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @return a DateTime using the same millis</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     */</em>
<a name="175" href="#175">175</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a> toDateTime(<a href="../../../../org/goda/time/Chronology.html">Chronology</a> chronology) {
<a name="176" href="#176">176</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/DateTime.html">DateTime</a>(getMillis(), chronology);
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <em class="jxr_comment">// NOTE: Although the toMutableDateTime methods could check to see if this</em>
<a name="180" href="#180">180</a>     <em class="jxr_comment">// is already a MutableDateTime and return this casted, it makes it too</em>
<a name="181" href="#181">181</a>     <em class="jxr_comment">// easy to mistakenly modify ReadableDateTime input parameters. Always</em>
<a name="182" href="#182">182</a>     <em class="jxr_comment">// returning a copy prevents this.</em>
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>     <em class="jxr_javadoccomment">/**</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * Get this object as a MutableDateTime in the same zone.</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     *</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     * @return a MutableDateTime using the same millis</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     */</em>
<a name="189" href="#189">189</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a> toMutableDateTime() {
<a name="190" href="#190">190</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a>(getMillis(), getZone());
<a name="191" href="#191">191</a>     }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>     <em class="jxr_javadoccomment">/**</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * Get this object as a MutableDateTime using ISOChronology in the same zone.</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     *</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * @return a MutableDateTime using the same millis with ISOChronology</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     */</em>
<a name="198" href="#198">198</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a> toMutableDateTimeISO() {
<a name="199" href="#199">199</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a>(getMillis(), ISOChronology.getInstance(getZone()));
<a name="200" href="#200">200</a>     }
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a>     <em class="jxr_javadoccomment">/**</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * Get this object as a MutableDateTime using the same chronology but a different zone.</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * </em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @param zone time zone to apply, or default if null</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * @return a MutableDateTime using the same millis</em>
<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     */</em>
<a name="208" href="#208">208</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a> toMutableDateTime(<a href="../../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> zone) {
<a name="209" href="#209">209</a>         <a href="../../../../org/goda/time/Chronology.html">Chronology</a> chrono = DateTimeUtils.getChronology(getChronology());
<a name="210" href="#210">210</a>         chrono = chrono.withZone(zone);
<a name="211" href="#211">211</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a>(getMillis(), chrono);
<a name="212" href="#212">212</a>     }
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>     <em class="jxr_javadoccomment">/**</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * Get this object as a MutableDateTime using the given chronology and its zone.</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * </em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * @param chronology chronology to apply, or ISOChronology if null</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * @return a MutableDateTime using the same millis</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     */</em>
<a name="220" href="#220">220</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a> toMutableDateTime(<a href="../../../../org/goda/time/Chronology.html">Chronology</a> chronology) {
<a name="221" href="#221">221</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutableDateTime.html">MutableDateTime</a>(getMillis(), chronology);
<a name="222" href="#222">222</a>     }
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="225" href="#225">225</a>     <em class="jxr_javadoccomment">/**</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * Get the date time as a &lt;code&gt;java.util.Date&lt;/code&gt;.</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * The &lt;code&gt;Date&lt;/code&gt; object created has exactly the same millisecond</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     * instant as this object.</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     *</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * @return a Date initialised with this datetime</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     */</em>
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">public</strong> Date toDate() {
<a name="234" href="#234">234</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> Date(getMillis());
<a name="235" href="#235">235</a>     }
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="238" href="#238">238</a>     <em class="jxr_javadoccomment">/**</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for equality based</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * on the millisecond instant, chronology and time zone.</em>
<a name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * Two objects which represent the same instant in time, but are in</em>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * different time zones (based on time zone id), will be considered to</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * be different. Only two objects with the same {@link DateTimeZone},</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * {@link Chronology} and instant are equal.</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * See {@link #isEqual(ReadableInstant)} for an equals method that</em>
<a name="248" href="#248">248</a> <em class="jxr_javadoccomment">     * ignores the Chronology and time zone.</em>
<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="250" href="#250">250</a> <em class="jxr_javadoccomment">     * All ReadableInstant instances are accepted.</em>
<a name="251" href="#251">251</a> <em class="jxr_javadoccomment">     *</em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * @param readableInstant  a readable instant to check against</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     * @return true if millisecond and chronology are equal, false if</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     *  not or the instant is null or of an incorrect type</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     */</em>
<a name="256" href="#256">256</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object readableInstant) {
<a name="257" href="#257">257</a>         <em class="jxr_comment">// must be to fulfil ReadableInstant contract</em>
<a name="258" href="#258">258</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == readableInstant) {
<a name="259" href="#259">259</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="260" href="#260">260</a>         }
<a name="261" href="#261">261</a>         <strong class="jxr_keyword">if</strong> (readableInstant instanceof ReadableInstant == false) {
<a name="262" href="#262">262</a>             <strong class="jxr_keyword">return</strong> false;
<a name="263" href="#263">263</a>         }
<a name="264" href="#264">264</a>         <a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> otherInstant = (ReadableInstant) readableInstant;
<a name="265" href="#265">265</a>         <strong class="jxr_keyword">return</strong>
<a name="266" href="#266">266</a>             getMillis() == otherInstant.getMillis() &amp;&amp;
<a name="267" href="#267">267</a>             FieldUtils.equals(getChronology(), otherInstant.getChronology());
<a name="268" href="#268">268</a>     }
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>     <em class="jxr_javadoccomment">/**</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * Gets a hash code for the instant as defined in &lt;code&gt;ReadableInstant&lt;/code&gt;.</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     *</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * @return a suitable hash code</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     */</em>
<a name="275" href="#275">275</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a name="276" href="#276">276</a>         <em class="jxr_comment">// must be to fulfil ReadableInstant contract</em>
<a name="277" href="#277">277</a>         <strong class="jxr_keyword">return</strong>
<a name="278" href="#278">278</a>             ((<strong class="jxr_keyword">int</strong>) (getMillis() ^ (getMillis() &gt;&gt;&gt; 32))) +
<a name="279" href="#279">279</a>             (getChronology().hashCode());
<a name="280" href="#280">280</a>     }
<a name="281" href="#281">281</a> 
<a name="282" href="#282">282</a>     <em class="jxr_javadoccomment">/**</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for ascending</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * millisecond instant order. This ordering is inconsistent with</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * equals, as it ignores the Chronology.</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     * All ReadableInstant instances are accepted.</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     *</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     * @param instant  a readable instant to check against</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * @return negative value if this is less, 0 if equal, or positive value if greater</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * @throws NullPointerException if the object is null</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * @throws ClassCastException if the object type is not supported</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     */</em>
<a name="294" href="#294">294</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compareTo(Object instant) {
<a name="295" href="#295">295</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == instant) {
<a name="296" href="#296">296</a>             <strong class="jxr_keyword">return</strong> 0;
<a name="297" href="#297">297</a>         }
<a name="298" href="#298">298</a>         
<a name="299" href="#299">299</a>         <a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> otherInstant = (ReadableInstant) instant;
<a name="300" href="#300">300</a>         
<a name="301" href="#301">301</a>         <strong class="jxr_keyword">long</strong> otherMillis = otherInstant.getMillis();
<a name="302" href="#302">302</a>         <strong class="jxr_keyword">long</strong> thisMillis = getMillis();
<a name="303" href="#303">303</a>         
<a name="304" href="#304">304</a>         <em class="jxr_comment">// cannot do (thisMillis - otherMillis) as can overflow</em>
<a name="305" href="#305">305</a>         <strong class="jxr_keyword">if</strong> (thisMillis == otherMillis) {
<a name="306" href="#306">306</a>             <strong class="jxr_keyword">return</strong> 0;
<a name="307" href="#307">307</a>         }
<a name="308" href="#308">308</a>         <strong class="jxr_keyword">if</strong> (thisMillis &lt; otherMillis) {
<a name="309" href="#309">309</a>             <strong class="jxr_keyword">return</strong> -1;
<a name="310" href="#310">310</a>         } <strong class="jxr_keyword">else</strong> {
<a name="311" href="#311">311</a>             <strong class="jxr_keyword">return</strong> 1;
<a name="312" href="#312">312</a>         }
<a name="313" href="#313">313</a>     }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="316" href="#316">316</a>     <em class="jxr_javadoccomment">/**</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * Is this instant after the millisecond instant passed in</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">     *</em>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">     * @param instant  a millisecond instant to check against</em>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">     * @return true if this instant is after the instant passed in</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     */</em>
<a name="323" href="#323">323</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAfter(<strong class="jxr_keyword">long</strong> instant) {
<a name="324" href="#324">324</a>         <strong class="jxr_keyword">return</strong> (getMillis() &gt; instant);
<a name="325" href="#325">325</a>     }
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>     <em class="jxr_javadoccomment">/**</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * Is this instant after the current instant</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * </em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     * @return true if this instant is after the current instant</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     */</em>
<a name="333" href="#333">333</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAfterNow() {
<a name="334" href="#334">334</a>         <strong class="jxr_keyword">return</strong> isAfter(DateTimeUtils.currentTimeMillis());
<a name="335" href="#335">335</a>     }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <em class="jxr_javadoccomment">/**</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     * Is this instant after the instant passed in</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment">     *</em>
<a name="341" href="#341">341</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="342" href="#342">342</a> <em class="jxr_javadoccomment">     * @return true if the instant is after the instant passed in</em>
<a name="343" href="#343">343</a> <em class="jxr_javadoccomment">     */</em>
<a name="344" href="#344">344</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAfter(<a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant) {
<a name="345" href="#345">345</a>         <strong class="jxr_keyword">long</strong> instantMillis = DateTimeUtils.getInstantMillis(instant);
<a name="346" href="#346">346</a>         <strong class="jxr_keyword">return</strong> isAfter(instantMillis);
<a name="347" href="#347">347</a>     }
<a name="348" href="#348">348</a> 
<a name="349" href="#349">349</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="350" href="#350">350</a>     <em class="jxr_javadoccomment">/**</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * Is this instant before the millisecond instant passed in</em>
<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="353" href="#353">353</a> <em class="jxr_javadoccomment">     *</em>
<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * @param instant  a millisecond instant to check against</em>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     * @return true if this instant is before the instant passed in</em>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment">     */</em>
<a name="357" href="#357">357</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isBefore(<strong class="jxr_keyword">long</strong> instant) {
<a name="358" href="#358">358</a>         <strong class="jxr_keyword">return</strong> (getMillis() &lt; instant);
<a name="359" href="#359">359</a>     }
<a name="360" href="#360">360</a> 
<a name="361" href="#361">361</a>     <em class="jxr_javadoccomment">/**</em>
<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">     * Is this instant before the current instant</em>
<a name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * </em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * @return true if this instant is before the current instant</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment">     */</em>
<a name="367" href="#367">367</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isBeforeNow() {
<a name="368" href="#368">368</a>         <strong class="jxr_keyword">return</strong> isBefore(DateTimeUtils.currentTimeMillis());
<a name="369" href="#369">369</a>     }
<a name="370" href="#370">370</a> 
<a name="371" href="#371">371</a>     <em class="jxr_javadoccomment">/**</em>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * Is this instant before the instant passed in</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     *</em>
<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="376" href="#376">376</a> <em class="jxr_javadoccomment">     * @return true if the instant is before the instant passed in</em>
<a name="377" href="#377">377</a> <em class="jxr_javadoccomment">     */</em>
<a name="378" href="#378">378</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isBefore(<a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant) {
<a name="379" href="#379">379</a>         <strong class="jxr_keyword">long</strong> instantMillis = DateTimeUtils.getInstantMillis(instant);
<a name="380" href="#380">380</a>         <strong class="jxr_keyword">return</strong> isBefore(instantMillis);
<a name="381" href="#381">381</a>     }
<a name="382" href="#382">382</a> 
<a name="383" href="#383">383</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="384" href="#384">384</a>     <em class="jxr_javadoccomment">/**</em>
<a name="385" href="#385">385</a> <em class="jxr_javadoccomment">     * Is this instant equal to the millisecond instant passed in</em>
<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="387" href="#387">387</a> <em class="jxr_javadoccomment">     *</em>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * @param instant  a millisecond instant to check against</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     * @return true if this instant is before the instant passed in</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment">     */</em>
<a name="391" href="#391">391</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEqual(<strong class="jxr_keyword">long</strong> instant) {
<a name="392" href="#392">392</a>         <strong class="jxr_keyword">return</strong> (getMillis() == instant);
<a name="393" href="#393">393</a>     }
<a name="394" href="#394">394</a> 
<a name="395" href="#395">395</a>     <em class="jxr_javadoccomment">/**</em>
<a name="396" href="#396">396</a> <em class="jxr_javadoccomment">     * Is this instant equal to the current instant</em>
<a name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment">     * </em>
<a name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * @return true if this instant is before the current instant</em>
<a name="400" href="#400">400</a> <em class="jxr_javadoccomment">     */</em>
<a name="401" href="#401">401</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEqualNow() {
<a name="402" href="#402">402</a>         <strong class="jxr_keyword">return</strong> isEqual(DateTimeUtils.currentTimeMillis());
<a name="403" href="#403">403</a>     }
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a>     <em class="jxr_javadoccomment">/**</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment">     * Is this instant equal to the instant passed in</em>
<a name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * comparing solely by millisecond.</em>
<a name="408" href="#408">408</a> <em class="jxr_javadoccomment">     *</em>
<a name="409" href="#409">409</a> <em class="jxr_javadoccomment">     * @param instant  an instant to check against, null means now</em>
<a name="410" href="#410">410</a> <em class="jxr_javadoccomment">     * @return true if the instant is equal to the instant passed in</em>
<a name="411" href="#411">411</a> <em class="jxr_javadoccomment">     */</em>
<a name="412" href="#412">412</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEqual(<a href="../../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant) {
<a name="413" href="#413">413</a>         <strong class="jxr_keyword">long</strong> instantMillis = DateTimeUtils.getInstantMillis(instant);
<a name="414" href="#414">414</a>         <strong class="jxr_keyword">return</strong> isEqual(instantMillis);
<a name="415" href="#415">415</a>     }
<a name="416" href="#416">416</a> 
<a name="417" href="#417">417</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="418" href="#418">418</a>     <em class="jxr_javadoccomment">/**</em>
<a name="419" href="#419">419</a> <em class="jxr_javadoccomment">     * Output the date time in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ).</em>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">     * </em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment">     * @return ISO8601 time formatted string.</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment">     */</em>
<a name="423" href="#423">423</a>     <strong class="jxr_keyword">public</strong> String toString() {
<a name="424" href="#424">424</a>         <strong class="jxr_keyword">return</strong> ISODateTimeFormat.dateTime().print(<strong class="jxr_keyword">this</strong>);
<a name="425" href="#425">425</a>     }
<a name="426" href="#426">426</a> 
<a name="427" href="#427">427</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="428" href="#428">428</a>     <em class="jxr_javadoccomment">/**</em>
<a name="429" href="#429">429</a> <em class="jxr_javadoccomment">     * Uses the specified formatter to convert this partial to a String.</em>
<a name="430" href="#430">430</a> <em class="jxr_javadoccomment">     *</em>
<a name="431" href="#431">431</a> <em class="jxr_javadoccomment">     * @param formatter  the formatter to use, null means use &lt;code&gt;toString()&lt;/code&gt;.</em>
<a name="432" href="#432">432</a> <em class="jxr_javadoccomment">     * @return the formatted string</em>
<a name="433" href="#433">433</a> <em class="jxr_javadoccomment">     * @since 1.1</em>
<a name="434" href="#434">434</a> <em class="jxr_javadoccomment">     */</em>
<a name="435" href="#435">435</a>     <strong class="jxr_keyword">public</strong> String toString(<a href="../../../../org/goda/time/format/DateTimeFormatter.html">DateTimeFormatter</a> formatter) {
<a name="436" href="#436">436</a>         <strong class="jxr_keyword">if</strong> (formatter == <strong class="jxr_keyword">null</strong>) {
<a name="437" href="#437">437</a>             <strong class="jxr_keyword">return</strong> toString();
<a name="438" href="#438">438</a>         }
<a name="439" href="#439">439</a>         <strong class="jxr_keyword">return</strong> formatter.print(<strong class="jxr_keyword">this</strong>);
<a name="440" href="#440">440</a>     }
<a name="441" href="#441">441</a> 
<a name="442" href="#442">442</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

